replace fwd_scale with norm kwarg in mkl_fft
#189
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vtavana
requested review from
ndgrigorian,
antonwolfy,
xaleryb and
ekomarova
as code owners
vtavana
force-pushed
the
revisit_overwrite_x
branch
from
fb12707 to
31e17ab
Compare
vtavana
force-pushed
the
revisit_overwrite_x
branch
2 times, most recently
from
eadecd3 to
12677c0
Compare
vtavana
force-pushed
the
add-norm
branch
2 times, most recently
from
12de45d to
66c6ff2
Compare
antonwolfy
approved these changes
Jun 10, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR replaces the fwd_scale parameter with norm parameter in mkl_fft functions to align with NumPy and SciPy FFT interfaces. The change makes the API more consistent with standard FFT libraries.
- Replaced
fwd_scaleparameter withnormparameter across all FFT functions - Updated function signatures in both interface modules and core implementation
- Modified tests to use
normparameter instead offwd_scale
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkl_fft/_mkl_fft.py | Updated core FFT function signatures to use norm parameter and added internal computation of forward scale factor |
| mkl_fft/interfaces/_scipy_fft.py | Removed _compute_fwd_scale usage and passed norm directly to underlying FFT functions |
| mkl_fft/interfaces/_numpy_fft.py | Removed _compute_fwd_scale usage and passed norm directly to underlying FFT functions |
| mkl_fft/tests/test_fftnd.py | Updated test cases to use norm parameter, removed scaling-specific test class, added None value test |
| mkl_fft/_fft_utils.py | Minor string formatting improvements unrelated to main change |
| README.md | Updated function signatures in documentation to reflect norm parameter |
| CHANGELOG.md | Added entry documenting the parameter replacement |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Both NumPy and SciPy use
normparameter which is the normalization mode that is used scaling the FFT results.mkl_ffthas the scaling parameterfwd_scaledirectly. In this PR,fwd_scaleis replaced withnormto be aligned with NumPy and SciPy.